home *** CD-ROM | disk | FTP | other *** search
/ Greenhouse Effect Detection Expriment / NASA Greenhouse Effect Detection Expriment 1992 - Disc 2.iso / document / software.doc < prev   
Encoding:
Text File  |  1992-03-14  |  10.8 KB  |  240 lines

  1.              The Greenhouse Effect Detection Experiment CD-ROM
  2.                                    GEDEX
  3.  
  4.                         Guide to Supporting Software
  5.  
  6.                              Archibald Warnock
  7.                                     and
  8.                              John R. Vanderpool
  9.  
  10.                               Hughes STX Corp.
  11.                         7601 Ora Glen Dr., Suite 300
  12.                             Greenbelt, MD 20770
  13.  
  14.  
  15.  
  16. What is on this disk?
  17. ---------------------
  18.  
  19. This disk includes software to help you use the climate data sets included
  20. on it. The software and data together reproduce the functionality and
  21. appearance of NASA's Climate Data System (NCDS), an interactive scientific
  22. data management system for locating, accessing, manipulating and displaying
  23. data from NASA and other correlative research missions.  Using a unique
  24. approach we have designed this disk to run under five different operating
  25. systems: MS-DOS, SunOS, IRIX, and VMS (for specific information on using a
  26. particular system, refer to the corresponding section below).
  27.  
  28. This portable approach allows the software to be run on a variety of
  29. different terminals.  Therefore, the keys used will depend on the platform
  30. on which you run the CD-ROM.  We will attempt to keep this document simple
  31. (1) by referring to the status line at the bottom of each screen and (2) by
  32. referring to the keys by function (e.g., Next Page), rather than by name.
  33. The status line tells you which key strokes can be used to navigate the
  34. system.
  35.  
  36.  
  37.  
  38. How do I use this disk under MS-DOS?
  39. ------------------------------------
  40.  
  41. Under MS-DOS, make your CD-ROM drive the default drive and then change to
  42. the subdirectory \SOFTWARE\DOS.  Begin the program by entering the command
  43. "GEDEX" (which runs the batch file, GEDEX.BAT).  The batch file defines
  44. some environment variables which the program needs to find the necessary
  45. files, then runs the program.  GEDEX.BAT may be copied from the CD-ROM to
  46. another disk drive but requires minor editing to work properly.  See the
  47. section below on "Installing The GEDEX Program On Your Hard Disk".
  48.  
  49. You may get the error message "Out of environment space" when you first try
  50. to run the program.  If this happens, it can be corrected by adding the
  51. following line to the file CONFIG.SYS in the root directory of your boot
  52. drive:
  53.  
  54.             shell=command.com /e:nnn /p
  55.  
  56. where "nnn" is the number of bytes to reserve for environment space.  There
  57. may already be such a line in your CONFIG.SYS file.  If so, replace the
  58. value there with a larger number.  If you have to add such a line to
  59. CONFIG.SYS, try using 256 or, if that doesn't work, 512.  The default for
  60. MS-DOS version 3.3 is 160 bytes: you will want a larger value than that.
  61. You will need to reboot the computer for the change to take effect.
  62.  
  63. The program uses a technique which allows nearly all of your system's
  64. memory to be available to the programs in the "Data Utilities" menu.  This
  65. technique works by trying to swap out most of the memory used by the GEDEX
  66. program and leaving only a small "stub" of the program in memory.  When you
  67. run any of the programs from the "Data Utilities" menu, the GEDEX program
  68. tries to swap itself into extended (XMS) memory and, failing that, into
  69. expanded (EMS) memory.  If you have enough of either of these types of
  70. memory available, the swap will happen automatically.  Should the program
  71. not be able to allocate enough memory to swap itself out, it will attempt
  72. to swap to a disk file.  This is slower than swapping to memory but will
  73. still work.  The GEDEX program looks for the environment variable TMP to
  74. decide where to write the scratch swap file.
  75.  
  76. If none of these options works, the GEDEX program will keep itself in
  77. memory, leaving less available to the utility programs.
  78.  
  79.  
  80.  
  81. Installing The GEDEX Program On Your Hard Disk
  82. ----------------------------------------------
  83.  
  84. You can copy all of the files from the \SOFTWARE\DOS subdirectory on the
  85. CD-ROM to any directory on your hard disk.  In order for the software to
  86. run correctly, you will need to modify the GEDEX.BAT file to explicitly add
  87. the drive letter of your CD-ROM drive to the paths in the SET commands. See
  88. the comments in the GEDEX.BAT file for more specific instructions. Note
  89. also that the executable files JAM.EXE, CDFLIST.EXE, CDFWALK.EXE,
  90. CDFBROW.EXE and CDFINQ.EXE do not have to be located in the same place as
  91. GEDEX.BAT, provided the directory which contains them is included in the
  92. PATH statement.  PATH is set in the AUTOEXEC.BAT file found in the root
  93. directory of your boot disk.
  94.  
  95.  
  96.  
  97. How do I use this disk under Unix (SunOS and Irix)?
  98. ---------------------------------------------------
  99.  
  100. The software uses VT-100 emulation, so either use a character-based
  101. terminal, or use an xterm window (if you are using a bit-mapped display).
  102.  
  103. The executable files for each of the supported Unix platforms were compiled
  104. using the following operating systems:
  105.  
  106.     SunOS   4.1.1 1 sun4c        # Sun 4 (no Sun 3 support)
  107.     IRIX    4.0.1 11150233 IP12    # Iris
  108.  
  109.  
  110. Both the Bourne/Korn and C shells are supported.   
  111.  
  112. To use the Bourne or Korn shell for SunOS or Irix operating systems,
  113. "source" in the GEDEX Bourne shell initialization file with:
  114.  
  115. . /cdrom/software/sunos/gedex.sh
  116.  
  117. or
  118.  
  119. . /cdrom/software/irix/gedex.sh
  120.  
  121. To use the C shell for SunOS or Irix operating systems, "source" in the
  122. GEDEX C shell initialization file with:
  123.  
  124. source /cdrom/software/sunos/gedex.csh
  125.  
  126. or
  127.  
  128. source /cdrom/software/irix/gedex.csh
  129.  
  130.  
  131.  
  132. How do I use this disk under VMS?
  133. --------------------------------
  134.  
  135. The VAX/VMS version of the software was created using VMS version 5.4-3
  136. with no shared libraries.  The software should run on any VAX/VMS platform;
  137. however, files on CD-ROM drives are unpredictable because of DEC's
  138. implementation of the ISO 9660-compatible driver software.
  139.  
  140. To run the initialization at the DCL $ prompt enter:
  141.  
  142. $ @dub255:[software.vms]gedex.com
  143.  
  144. substituting your CD-ROM device name for dub255.  Enter the same
  145. information when the command procedure prompts you.
  146.  
  147.  
  148.  
  149. What do I see when I run the software?
  150. -------------------------------------
  151.  
  152. When the program begins, an initial menu screen is displayed. The screen
  153. contains eight-character file names, along with descriptions of the data
  154. sets.  Select a data set by moving the cursor to highlight the line
  155. containing the desired file name and description.  Press the key for
  156. "Select":  a screen of summary information will be displayed which
  157. corresponds to the data set chosen.  Under MS-DOS, you can also use a
  158. mouse.  Place the mouse cursor on your choice, and click the left mouse
  159. button to make your selection.
  160.  
  161. The summary screen has a menu in the upper right corner, with the options
  162. "Parameters", "Sources & Sensors", "Detailed Catalog" and "Data Utilities."
  163. The first two give additional summary information about the data set.
  164. Selecting "Detailed Catalog" gives a table of contents for the
  165. documentation file describing the data set. You can select any section of
  166. the catalog by highlighting the line in the table of contents, then
  167. pressing the key for "Select."  Remember, the status line at the bottom of
  168. the screen will tell you what keys are active and how to exit. Note that
  169. you can use the summary screen like a Rolodex by using the keystrokes
  170. corresponding to "Prev Card" and "Next Card".  This avoids having to go
  171. back to the product menu screen repeatedly.
  172.  
  173. The fourth menu selection, "Data Utilities" allows you the option of
  174. running some utility programs on the selected data set.  Each of these
  175. programs has its own documentation (in the DOCUMENT directory) or help from
  176. inside the program itself.  The last selection on the "Data Utilities" menu
  177. is "Shell". Selecting this option will temporarily transfer you to the
  178. operating system.  The command to transfer you back into the GEDEX program
  179. after spawning out depends on the operating system you are running.  Type
  180. "exit" under MS-DOS or Unix.  Type "logoff" under VMS.  To return to the
  181. "Data Utilities" menu after running any of the options, press the space
  182. bar.
  183.  
  184.  
  185. How are the data stored on this disk?
  186. -------------------------------------
  187.  
  188. All of the data on this disk are stored in the DATA subdirectory.  The
  189. files are binary, written in the NASA/GSFC Common Data Format (CDF). They
  190. are network-encoded for portability and are written with the single file
  191. option for simplicity.  If you use the tools supplied through the Utility
  192. Menu of the GEDEX program, you will not have to concern yourself with the
  193. data format.  If you want to understand this format for use with your own
  194. software packages or you wish to build your own tools, you can print out
  195. the full documentation (CDFDOC.PS, which is a Postscript file located in
  196. the \SOFTWARE\CDF subdirectory) or contact the CDF Support Office at
  197. 301-286-9506 or via e-mail on the Internet: cdfsupport@nssdc.gsfc.nasa.gov.
  198.  
  199.  
  200. How do I get data into an ASCII file?
  201. -------------------------------------
  202.  
  203. The utility program CDFLIST has the capability to write a subset of a data
  204. set out to an ASCII file.  You can run CDFLIST from the "Data Utilites"
  205. menu choice in the GEDEX software.  Once inside the CDFLIST program, select
  206. the "FILE" or "FILE/TERMINAL" option from the output menu.  You will be
  207. prompted for the name of the output file.  After you have selected the
  208. variables you wish to extract, and have set the limits on which you want to
  209. filter the data, go to the "Action Menu" (by pressing Ctrl-F) and choose
  210. the "Generate Output" option.  Your data will be sent to the output file,
  211. one variable per column.
  212.  
  213.  
  214. How do I get help from the GEDEX programming staff?
  215. ---------------------------------------------------
  216.  
  217. Contact either Archibald (Archie) Warnock at 301-513-1685 or via e-mail on
  218. the Internet at warnock@nssdca.gsfc.nasa.gov (warnock@128.183.36.23)
  219.  
  220. or John (Fish) Vanderpool at 301-513-1683 or via e-mail on the Internet at
  221. vander@nssdca.gsfc.nasa.gov (vander@128.183.36.23)
  222.  
  223.  
  224. Special Thanks
  225. --------------
  226.  
  227. We owe many thanks to Jeff Love and Howard Leckner of Hughes STX and the
  228. CDF Project.  Not only have they ably developed and maintained the CDF
  229. library and tools for general use, but their persistent efforts and
  230. responsiveness to suggestions brought the MS-DOS port of the CDF tools to
  231. distributable form.  We could never have developed the portable software
  232. for a project such as this without them.
  233.  
  234. We also wish to extend special thanks to Daniel Ziskin, a graduate student
  235. at Johns Hopkins University, funded through NASA grant NAG5-1476.  He
  236. carefully tested the software, data, and documentation during the final
  237. phases of preparation of the disks.  His gift of time and patience, and his
  238. willingness to serve as our primary "trial-run science user" will long be
  239. appreciated by our staff and the users of this disk.
  240.